/*
 * Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.truffle.api.test.profiles;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

import org.junit.BeforeClass;
import org.junit.Test;

import com.oracle.truffle.api.dsl.InlineSupport.InlinableField;
import com.oracle.truffle.api.profiles.BranchProfile;
import com.oracle.truffle.api.profiles.InlinedBranchProfile;
import com.oracle.truffle.tck.tests.TruffleTestAssumptions;

public class BranchProfileTest extends AbstractProfileTest {

    @BeforeClass
    public static void runWithWeakEncapsulationOnly() {
        TruffleTestAssumptions.assumeWeakEncapsulation();
    }

    @Override
    protected InlinableField[] getInlinedFields() {
        return createInlinedFields(1, 0, 0, 0, 0);
    }

    @Test
    public void testEnter() {
        BranchProfile profile = createEnabled(BranchProfile.class);

        assertTrue(toString(profile).contains(BranchProfile.class.getSimpleName()));
        assertTrue(toString(profile).contains("UNINITIALIZED"));
        assertTrue(toString(profile).contains(Integer.toHexString(profile.hashCode())));

        profile.enter();

        assertTrue(toString(profile).contains(BranchProfile.class.getSimpleName()));
        assertTrue(toString(profile).contains("VISITED"));
        assertTrue(toString(profile).contains(Integer.toHexString(profile.hashCode())));
    }

    @Test
    public void testEnterInlined() {
        InlinedBranchProfile profile = createEnabled(InlinedBranchProfile.class);

        assertTrue(toString(profile).contains(BranchProfile.class.getSimpleName()));
        assertTrue(toString(profile).contains("UNINITIALIZED"));
        assertTrue(toString(profile).contains(Integer.toHexString(profile.hashCode())));

        if (isInlined(profile)) {
            assertEquals(0, state.state0);
        }

        profile.enter(state);

        assertTrue(toString(profile).contains(BranchProfile.class.getSimpleName()));
        assertTrue(toString(profile).contains("VISITED"));
        assertTrue(toString(profile).contains(Integer.toHexString(profile.hashCode())));

        assertEquals(1, state.state0);
    }

    @Test
    public void testNotCrashing() {
        BranchProfile profile = createEnabled(BranchProfile.class);
        profile.disable();
        profile.reset();
        assertEquals(profile, profile);
        assertEquals(profile.hashCode(), profile.hashCode());
        assertNotNull(profile.toString());
    }

    @Test
    public void testNotCrashingInlined() {
        InlinedBranchProfile profile = createEnabled(InlinedBranchProfile.class);
        profile.disable(state);
        profile.reset(state);
        assertEquals(profile, profile);
        assertEquals(profile.hashCode(), profile.hashCode());
        assertNotNull(profile.toString());
    }

    @Test
    public void testDisabled() {
        BranchProfile p = BranchProfile.getUncached();
        p.enter();
        p.toString(); // test that it is not crashing
    }

    @Test
    public void testDisabledInlined() {
        InlinedBranchProfile p = InlinedBranchProfile.getUncached();
        p.enter(state);
        p.toString(); // test that it is not crashing
    }
}
